/*
 * $Id:   Broadcom SDK $
 * 
 * $Copyright: Copyright 2011 Broadcom Corporation.
 * This program is the proprietary software of Broadcom Corporation
 * and/or its licensors, and may only be used, duplicated, modified
 * or distributed pursuant to the terms and conditions of a separate,
 * written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized
 * License, Broadcom grants no license (express or implied), right
 * to use, or waiver of any kind with respect to the Software, and
 * Broadcom expressly reserves all rights in and to the Software
 * and all intellectual property rights therein.  IF YOU HAVE
 * NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS SOFTWARE
 * IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE
 * ALL USE OF THE SOFTWARE.  
 *  
 * Except as expressly set forth in the Authorized License,
 *  
 * 1.     This program, including its structure, sequence and organization,
 * constitutes the valuable trade secrets of Broadcom, and you shall use
 * all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of
 * Broadcom integrated circuit products.
 *  
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS
 * PROVIDED "AS IS" AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES,
 * REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY,
 * OR OTHERWISE, WITH RESPECT TO THE SOFTWARE.  BROADCOM SPECIFICALLY
 * DISCLAIMS ANY AND ALL IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY,
 * NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES,
 * ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING
 * OUT OF USE OR PERFORMANCE OF THE SOFTWARE.
 * 
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL
 * BROADCOM OR ITS LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL,
 * INCIDENTAL, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES WHATSOEVER
 * ARISING OUT OF OR IN ANY WAY RELATING TO YOUR USE OF OR INABILITY
 * TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF
 * THE AMOUNT ACTUALLY PAID FOR THE SOFTWARE ITSELF OR USD 1.00,
 * WHICHEVER IS GREATER. THESE LIMITATIONS SHALL APPLY NOTWITHSTANDING
 * ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY.$
 * 
 * DO NOT EDIT THIS FILE!
 * This file is auto-generated.
 * Edits to this file will be lost when it is regenerated.
 */

#ifndef __BCM_TXBEACON_H__
#define __BCM_TXBEACON_H__

#include <bcm/types.h>
#include <bcm/pkt.h>

/* bcm_txbeacon_t flags definitions */
#define BCM_TXBEACON_WITH_ID    (1 << 0)   /* Set if TX Beacon structure has ID */
#define BCM_TXBEACON_AUTOSTART  (1 << 1)   /* Set if uCs should start beacon on
                                              loss of keepalive */

/* Unique packet ID shared with uCs. */
typedef uint32 bcm_txbeacon_pkt_id_t;

/* Tx Beacon basic data structure. */
typedef struct bcm_txbeacon_s {
    uint32 flags;                   /* Flags indicating action of API */
    uint16 len;                     /* length of packet in bytes. NOTE: IN/OUT */
    uint16 maxlen;                  /* maximum length in case of modification.
                                       NOTE: IN/OUT */
    bcm_txbeacon_pkt_id_t pkt_id;   /* Packet ID from the uC.  NOTE: IN/OUT */
    uint16 port;                    /* port to send packet to */
    uint16 interval;                /* interval to send packet in mSeconds */
    uint16 count;                   /* Number of packets to send or 0 (forever) */
    uint8 *pkt_data;                /* Pointer to packet NOTE: IN/OUT */
} bcm_txbeacon_t;

/* tx beacon traverse callback */
typedef int (*bcm_txbeacon_traverse_cb_t)(
    int unit, 
    bcm_txbeacon_t *tx, 
    void *user_data);

#ifndef BCM_HIDE_DISPATCHABLE

/* Traverse tx beacon objects */
extern int bcm_txbeacon_traverse(
    int unit, 
    bcm_txbeacon_traverse_cb_t trav_fn, 
    void *user_data);

/* Initialize tx beacon. */
extern int bcm_txbeacon_init(
    int unit, 
    int uC);

/* Set up or modify a packet to beacon. */
extern int bcm_txbeacon_pkt_setup(
    int unit, 
    bcm_txbeacon_t *txbeacon);

/* Remove a packet from the beacon */
extern int bcm_txbeacon_destroy(
    int unit, 
    bcm_txbeacon_pkt_id_t pkt_id);

/* Get info on packet. */
extern int bcm_txbeacon_pkt_get(
    int unit, 
    bcm_txbeacon_t *txbeacon);

/* Start beacon of packet(s). */
extern int bcm_txbeacon_start(
    int unit, 
    bcm_txbeacon_pkt_id_t pkt_id);

/* Stop beacon of packet(s). */
extern int bcm_txbeacon_stop(
    int unit, 
    bcm_txbeacon_pkt_id_t pkt_id);

#endif /* BCM_HIDE_DISPATCHABLE */

#endif /* __BCM_TXBEACON_H__ */
